home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 July: Technology Seed / ATS July '97.toast / Mac OS 8 / Docs-Interfaces-Libs / Text Encoding Convertors / Interfaces / TextCommon.h < prev    next >
Encoding:
C/C++ Source or Header  |  1997-05-23  |  15.9 KB  |  371 lines  |  [TEXT/MPS ]
  1. /*
  2.      File:        TextCommon.h
  3.  
  4.      Contains:    Definitions for common text types, values for them, and related routines 
  5.  
  6.      Version:    System 7.7
  7.  
  8.      DRI:        Peter Edberg
  9.  
  10.      Copyright:    © 1984-1996 by Apple Computer, Inc.
  11.                  All rights reserved.
  12.  
  13.      Warning:    *** APPLE INTERNAL USE ONLY ***
  14.                  This file may contain unreleased API's
  15.  
  16.      BuildInfo:    Built by:            Sue Kuo
  17.                  With Interfacer:    2.0d13   (PowerPC native)
  18.                  From:                TextCommon.i
  19.                      Revision:        35
  20.                      Dated:            4/23/97
  21.                      Last change by:    PKE
  22.                      Last comment:    #1649885: Add kTextEncodingMacVT100 encoding
  23.  
  24.      Bugs:        Report bugs to Radar component “System Interfaces”, “Latest”
  25.                  List the version information (from above) in the Problem Description.
  26.  
  27. */
  28. #ifndef __TEXTCOMMON__
  29. #define __TEXTCOMMON__
  30.  
  31. #ifndef __TYPES__
  32. #include <Types.h>
  33. #endif
  34.  
  35. #ifdef __cplusplus
  36. extern "C" {
  37. #endif
  38.  
  39. #if PRAGMA_IMPORT_SUPPORTED
  40. #pragma import on
  41. #endif
  42.  
  43. #if PRAGMA_ALIGN_SUPPORTED
  44. #pragma options align=mac68k
  45. #endif
  46.  
  47. #if 0
  48. /*
  49.  The following 7 typedefs are required for seeds until they get
  50.  moved to a future version of Types.[hp] in a future ETO release.
  51.  Also note that seeds should include a copy of the new TextCommon.[hp].
  52. */
  53. typedef UInt8 *BytePtr;
  54. typedef UInt32 ByteCount;
  55. typedef UInt32 ItemCount;
  56. typedef UInt32 OptionBits;
  57. typedef short RegionCode;
  58. typedef UInt32 ByteOffset;
  59. typedef const void *ConstLogicalAddress;
  60. /*
  61.  The following typedefs are required for seeds until they get
  62.  moved to a future version of Errors.[hp] in a future ETO release.
  63.  Text Encoding Converter & Unicode Converter Error Codes, for reference
  64. */
  65.  
  66. enum {
  67.                                                                 /* general text errors*/
  68.     kTextUnsupportedEncodingErr    = -8738,                        /* specified encoding not supported for this operation*/
  69.     kTextMalformedInputErr        = -8739,                        /* in DBCS, for example, high byte followed by invalid low byte*/
  70.     kTextUndefinedElementErr    = -8740,                        /* text conversion errors*/
  71.     kTECMissingTableErr            = -8745,
  72.     kTECTableChecksumErr        = -8746,
  73.     kTECTableFormatErr            = -8747,
  74.     kTECCorruptConverterErr        = -8748,                        /* invalid converter object reference*/
  75.     kTECNoConversionPathErr        = -8749,
  76.     kTECBufferBelowMinimumSizeErr = -8750,                        /* output buffer too small to allow processing of first input text element*/
  77.     kTECArrayFullErr            = -8751,                        /* supplied name buffer or TextRun, TextEncoding, or UnicodeMapping array is too small*/
  78.     kTECBadTextRunErr            = -8752,
  79.     kTECPartialCharErr            = -8753,                        /* input buffer ends in the middle of a multibyte character, conversion stopped*/
  80.     kTECUnmappableElementErr    = -8754,
  81.     kTECIncompleteElementErr    = -8755,                        /* text element may be incomplete or is too long for internal buffers*/
  82.     kTECDirectionErr            = -8756,                        /* direction stack overflow, etc.*/
  83.                                                                 /* text conversion status codes*/
  84.     kTECUsedFallbacksStatus        = -8783,
  85.     kTECNeedFlushStatus            = -8784,
  86.     kTECOutputBufferFullStatus    = -8785,                        /* output buffer has no room for conversion of next input text element (partial conversion)*/
  87.                                                                 /* deprecated error & status codes for low-level converter, now unused*/
  88.     unicodeChecksumErr            = -8769,
  89.     unicodeNoTableErr            = -8768,
  90.     unicodeVariantErr            = -8767,
  91.     unicodeFallbacksErr            = -8766,
  92.     unicodePartConvertErr        = -8765,
  93.     unicodeBufErr                = -8764,
  94.     unicodeCharErr                = -8763,
  95.     unicodeElementErr            = -8762,
  96.     unicodeNotFoundErr            = -8761,
  97.     unicodeTableFormatErr        = -8760,
  98.     unicodeDirectionErr            = -8759,
  99.     unicodeContextualErr        = -8758,
  100.     unicodeTextEncodingDataErr    = -8757
  101. };
  102.  
  103. #endif
  104. /* LocaleIdentifier is an obsolete Copland typedef, will be removed soon*/
  105. typedef UInt32 LocaleIdentifier;
  106. /* TextEncodingBase type & values */
  107. /* (values 0-32 correspond to the Script Codes defined in Inside Macintosh: Text pages 6-52 and 6-53 */
  108. typedef UInt32 TextEncodingBase;
  109.  
  110. enum {
  111.                                                                 /* Mac OS encodings*/
  112.     kTextEncodingMacRoman        = 0L,
  113.     kTextEncodingMacJapanese    = 1,
  114.     kTextEncodingMacChineseTrad    = 2,
  115.     kTextEncodingMacKorean        = 3,
  116.     kTextEncodingMacArabic        = 4,
  117.     kTextEncodingMacHebrew        = 5,
  118.     kTextEncodingMacGreek        = 6,
  119.     kTextEncodingMacCyrillic    = 7,
  120.     kTextEncodingMacDevanagari    = 9,
  121.     kTextEncodingMacGurmukhi    = 10,
  122.     kTextEncodingMacGujarati    = 11,
  123.     kTextEncodingMacOriya        = 12,
  124.     kTextEncodingMacBengali        = 13,
  125.     kTextEncodingMacTamil        = 14,
  126.     kTextEncodingMacTelugu        = 15,
  127.     kTextEncodingMacKannada        = 16,
  128.     kTextEncodingMacMalayalam    = 17,
  129.     kTextEncodingMacSinhalese    = 18,
  130.     kTextEncodingMacBurmese        = 19,
  131.     kTextEncodingMacKhmer        = 20,
  132.     kTextEncodingMacThai        = 21,
  133.     kTextEncodingMacLaotian        = 22,
  134.     kTextEncodingMacGeorgian    = 23,
  135.     kTextEncodingMacArmenian    = 24,
  136.     kTextEncodingMacChineseSimp    = 25,
  137.     kTextEncodingMacTibetan        = 26,
  138.     kTextEncodingMacMongolian    = 27,
  139.     kTextEncodingMacEthiopic    = 28,
  140.     kTextEncodingMacCentralEurRoman = 29,
  141.     kTextEncodingMacVietnamese    = 30,
  142.     kTextEncodingMacExtArabic    = 31,                            /* The following use script code 0, smRoman*/
  143.     kTextEncodingMacSymbol        = 33,
  144.     kTextEncodingMacDingbats    = 34,
  145.     kTextEncodingMacTurkish        = 35,
  146.     kTextEncodingMacCroatian    = 36,
  147.     kTextEncodingMacIcelandic    = 37,
  148.     kTextEncodingMacRomanian    = 38,                            /* The following use script code 4, smArabic*/
  149.     kTextEncodingMacFarsi        = 0x8C,                            /* Like MacArabic but uses Farsi digits*/
  150.                                                                 /* The following use script code 7, smCyrillic*/
  151.     kTextEncodingMacUkrainian    = 0x98,                            /* The following use script code 32, smUnimplemented*/
  152.     kTextEncodingMacVT100        = 0xFC,                            /* VT100/102 font from Comm Toolbox: Latin-1 repertoire + box drawing etc*/
  153.                                                                 /* Special Mac OS encodings*/
  154.     kTextEncodingMacHFS            = 0xFF,                            /* Meta-value, should never appear in a table.*/
  155.                                                                 /* Unicode & ISO UCS encodings begin at 0x100*/
  156.     kTextEncodingUnicodeDefault    = 0x0100,                        /* Meta-value, should never appear in a table.*/
  157.     kTextEncodingUnicodeV1_1    = 0x0101,
  158.     kTextEncodingISO10646_1993    = 0x0101,                        /* Code points identical to Unicode 1.1*/
  159.     kTextEncodingUnicodeV2_0    = 0x0103,                        /* New location for Korean Hangul*/
  160.                                                                 /* ISO 8-bit and 7-bit encodings begin at 0x200*/
  161.     kTextEncodingISOLatin1        = 0x0201,                        /* ISO 8859-1*/
  162.     kTextEncodingISOLatin2        = 0x0202,                        /* ISO 8859-2*/
  163.     kTextEncodingISOLatinCyrillic = 0x0205,                        /* ISO 8859-5*/
  164.     kTextEncodingISOLatinArabic    = 0x0206,                        /* ISO 8859-6, = ASMO 708, =DOS CP 708*/
  165.     kTextEncodingISOLatinGreek    = 0x0207,                        /* ISO 8859-7*/
  166.     kTextEncodingISOLatinHebrew    = 0x0208,                        /* ISO 8859-8*/
  167.     kTextEncodingISOLatin5        = 0x0209,                        /* ISO 8859-9*/
  168.                                                                 /* MS-DOS & Windows encodings begin at 0x400*/
  169.     kTextEncodingDOSLatinUS        = 0x0400,                        /* code page 437*/
  170.     kTextEncodingDOSGreek        = 0x0405,                        /* code page 737 (formerly code page 437G)*/
  171.     kTextEncodingDOSBalticRim    = 0x0406,                        /* code page 775*/
  172.     kTextEncodingDOSLatin1        = 0x0410,                        /* code page 850, "Multilingual"*/
  173.     kTextEncodingDOSGreek1        = 0x0411,                        /* code page 851*/
  174.     kTextEncodingDOSLatin2        = 0x0412,                        /* code page 852, Slavic*/
  175.     kTextEncodingDOSCyrillic    = 0x0413,                        /* code page 855, IBM Cyrillic*/
  176.     kTextEncodingDOSTurkish        = 0x0414,                        /* code page 857, IBM Turkish*/
  177.     kTextEncodingDOSPortuguese    = 0x0415,                        /* code page 860*/
  178.     kTextEncodingDOSIcelandic    = 0x0416,                        /* code page 861*/
  179.     kTextEncodingDOSHebrew        = 0x0417,                        /* code page 862*/
  180.     kTextEncodingDOSCanadianFrench = 0x0418,                    /* code page 863*/
  181.     kTextEncodingDOSArabic        = 0x0419,                        /* code page 864*/
  182.     kTextEncodingDOSNordic        = 0x041A,                        /* code page 865*/
  183.     kTextEncodingDOSRussian        = 0x041B,                        /* code page 866*/
  184.     kTextEncodingDOSGreek2        = 0x041C,                        /* code page 869, IBM Modern Greek*/
  185.     kTextEncodingDOSThai        = 0x041D,                        /* code page 874, also for Windows*/
  186.     kTextEncodingDOSJapanese    = 0x0420,                        /* code page 932, also for Windows*/
  187.     kTextEncodingDOSChineseSimplif = 0x0421,                    /* code page 936, also for Windows*/
  188.     kTextEncodingDOSKorean        = 0x0422,                        /* code page 949, also for Windows; Unified Hangul Code*/
  189.     kTextEncodingDOSChineseTrad    = 0x0423,                        /* code page 950, also for Windows*/
  190.     kTextEncodingWindowsLatin1    = 0x0500,                        /* code page 1252*/
  191.     kTextEncodingWindowsANSI    = 0x0500,                        /* code page 1252 (alternate name)*/
  192.     kTextEncodingWindowsLatin2    = 0x0501,                        /* code page 1250, Central Europe*/
  193.     kTextEncodingWindowsCyrillic = 0x0502,                        /* code page 1251, Slavic Cyrillic*/
  194.     kTextEncodingWindowsGreek    = 0x0503,                        /* code page 1253*/
  195.     kTextEncodingWindowsLatin5    = 0x0504,                        /* code page 1254, Turkish*/
  196.     kTextEncodingWindowsHebrew    = 0x0505,                        /* code page 1255*/
  197.     kTextEncodingWindowsArabic    = 0x0506,                        /* code page 1256*/
  198.     kTextEncodingWindowsBalticRim = 0x0507,                        /* code page 1257*/
  199.     kTextEncodingWindowsKoreanJohab = 0x0510,                    /* code page 1361, for Windows NT*/
  200.                                                                 /* Various national standards begin at 0x600*/
  201.     kTextEncodingUS_ASCII        = 0x0600,
  202.     kTextEncodingJIS_X0201_76    = 0x0620,
  203.     kTextEncodingJIS_X0208_83    = 0x0621,
  204.     kTextEncodingJIS_X0208_90    = 0x0622,
  205.     kTextEncodingJIS_X0212_90    = 0x0623,
  206.     kTextEncodingJIS_C6226_78    = 0x0624,
  207.     kTextEncodingGB_2312_80        = 0x0630,
  208.     kTextEncodingGBK_95            = 0x0631,                        /* annex to GB 13000-93; for Windows 95*/
  209.     kTextEncodingKSC_5601_87    = 0x0640,                        /* same as KSC 5601-92 without Johab annex*/
  210.     kTextEncodingKSC_5601_92_Johab = 0x0641,                    /* KSC 5601-92 Johab annex*/
  211.     kTextEncodingCNS_11643_92_P1 = 0x0651,                        /* CNS 11643-1992 plane 1*/
  212.     kTextEncodingCNS_11643_92_P2 = 0x0652,                        /* CNS 11643-1992 plane 2*/
  213.     kTextEncodingCNS_11643_92_P3 = 0x0653,                        /* CNS 11643-1992 plane 3 (was plane 14 in 1986 version)*/
  214.                                                                 /* ISO 2022 collections begin at 0x800*/
  215.     kTextEncodingISO_2022_JP    = 0x0820,
  216.     kTextEncodingISO_2022_JP_2    = 0x0821,
  217.     kTextEncodingISO_2022_CN    = 0x0830,
  218.     kTextEncodingISO_2022_CN_EXT = 0x0831,
  219.     kTextEncodingISO_2022_KR    = 0x0840,                        /* EUC collections begin at 0x900*/
  220.     kTextEncodingEUC_JP            = 0x0920,                        /* ISO 646, 1-byte katakana, JIS 208, JIS 212*/
  221.     kTextEncodingEUC_CN            = 0x0930,                        /* ISO 646, GB 2312-80*/
  222.     kTextEncodingEUC_TW            = 0x0931,                        /* ISO 646, CNS 11643-1992 Planes 1-16*/
  223.     kTextEncodingEUC_KR            = 0x0940,                        /* ISO 646, KS C 5601-1987*/
  224.                                                                 /* Misc standards begin at 0xA00*/
  225.     kTextEncodingShiftJIS        = 0x0A01,                        /* plain Shift-JIS*/
  226.     kTextEncodingKOI8_R            = 0x0A02,                        /* Russian internet standard*/
  227.     kTextEncodingBig5            = 0x0A03,                        /* Big-5 (has variants)*/
  228.     kTextEncodingMacRomanLatin1    = 0x0A04,                        /* Mac OS Roman permuted to align with ISO Latin-1*/
  229.     kTextEncodingHZ_GB_2312        = 0x0A05,                        /* HZ (RFC 1842, for Chinese mail & news)*/
  230.                                                                 /* Other platform encodings*/
  231.     kTextEncodingNextStepLatin    = 0x0B01,                        /* NextStep encoding*/
  232.                                                                 /* Special value*/
  233.     kTextEncodingMultiRun        = 0x0FFF,                        /* Multi-encoding text with external run info*/
  234.                                                                 /* The following are older names for backward compatibility*/
  235.     kTextEncodingMacTradChinese    = 2,
  236.     kTextEncodingMacRSymbol        = 8,
  237.     kTextEncodingMacSimpChinese    = 25,
  238.     kTextEncodingMacGeez        = 28,
  239.     kTextEncodingMacEastEurRoman = 29,
  240.     kTextEncodingMacUninterp    = 32
  241. };
  242.  
  243. /* TextEncodingVariant type & values */
  244. typedef UInt32 TextEncodingVariant;
  245.  
  246. enum {
  247.                                                                 /* Default TextEncodingVariant, for any TextEncodingBase*/
  248.     kTextEncodingDefaultVariant    = 0,                            /* Variants of kTextEncodingMacJapanese*/
  249.     kMacJapaneseStandardVariant    = 0,
  250.     kMacJapaneseStdNoVerticalsVariant = 1,
  251.     kMacJapaneseBasicVariant    = 2,
  252.     kMacJapanesePostScriptScrnVariant = 3,
  253.     kMacJapanesePostScriptPrintVariant = 4,
  254.     kMacJapaneseVertAtKuPlusTenVariant = 5,                        /* Variant options for most Japanese encodings (MacJapanese, ShiftJIS, EUC-JP, ISO 2022-JP)    */
  255.                                                                 /* These can be OR-ed into the variant value in any combination*/
  256.     kJapaneseNoOneByteKanaOption = 0x20,
  257.     kJapaneseUseAsciiBackslashOption = 0x40,                    /* Variants of kTextEncodingMacArabic*/
  258.     kMacArabicStandardVariant    = 0,                            /* 0xC0 is 8-spoke asterisk, 0x2A & 0xAA are asterisk (e.g. Cairo)*/
  259.     kMacArabicTrueTypeVariant    = 1,                            /* 0xC0 is asterisk, 0x2A & 0xAA are multiply signs (e.g. Baghdad)*/
  260.     kMacArabicThuluthVariant    = 2,                            /* 0xC0 is Arabic five-point star, 0x2A & 0xAA are multiply signs*/
  261.     kMacArabicAlBayanVariant    = 3,                            /* 8-spoke asterisk, multiply sign, Koranic ligatures & parens*/
  262.                                                                 /* Variants of kTextEncodingMacFarsi*/
  263.     kMacFarsiStandardVariant    = 0,                            /* 0xC0 is 8-spoke asterisk, 0x2A & 0xAA are asterisk (e.g. Tehran)*/
  264.     kMacFarsiTrueTypeVariant    = 1,                            /* asterisk, multiply signs, Koranic ligatures, geometric shapes*/
  265.                                                                 /* Variants of kTextEncodingMacHebrew*/
  266.     kMacHebrewStandardVariant    = 0,
  267.     kMacHebrewFigureSpaceVariant = 1,                            /* Variants of Unicode & ISO 10646 encodings*/
  268.     kUnicodeNoSubset            = 0,
  269.     kUnicodeNoCompatibilityVariant = 1,
  270.     kUnicodeMaxDecomposedVariant = 2,
  271.     kUnicodeNoComposedVariant    = 3,
  272.     kUnicodeNoCorporateVariant    = 4,                            /* Variants of Big-5 encoding*/
  273.     kBig5_BasicVariant            = 0,
  274.     kBig5_StandardVariant        = 1,                            /* 0xC6A1-0xC7FC: kana, Cyrillic, enclosed numerics*/
  275.     kBig5_ETenVariant            = 2,                            /* adds kana, Cyrillic, radicals, etc with hi bytes C6-C8,F9*/
  276.                                                                 /* The following are older names for backward compatibility*/
  277.     kJapaneseStandardVariant    = 0,
  278.     kJapaneseStdNoVerticalsVariant = 1,
  279.     kJapaneseBasicVariant        = 2,
  280.     kJapanesePostScriptScrnVariant = 3,
  281.     kJapanesePostScriptPrintVariant = 4,
  282.     kJapaneseVertAtKuPlusTenVariant = 5,                        /* kJapaneseStdNoOneByteKanaVariant = 6,    // replaced by kJapaneseNoOneByteKanaOption*/
  283.                                                                 /* kJapaneseBasicNoOneByteKanaVariant = 7,    // replaced by kJapaneseNoOneByteKanaOption    */
  284.     kHebrewStandardVariant        = 0,
  285.     kHebrewFigureSpaceVariant    = 1
  286. };
  287.  
  288. /* TextEncodingFormat type & values */
  289. typedef UInt32 TextEncodingFormat;
  290.  
  291. enum {
  292.                                                                 /* Default TextEncodingFormat for any TextEncodingBase*/
  293.     kTextEncodingDefaultFormat    = 0,                            /* Formats for Unicode & ISO 10646*/
  294.     kUnicode16BitFormat            = 0,
  295.     kUnicodeUTF7Format            = 1,
  296.     kUnicodeUTF8Format            = 2,
  297.     kUnicode32BitFormat            = 3
  298. };
  299.  
  300. /* TextEncoding type */
  301. typedef UInt32 TextEncoding;
  302. /* name part selector for GetTextEncodingName*/
  303. typedef UInt32 TextEncodingNameSelector;
  304.  
  305. enum {
  306.     kTextEncodingFullName        = 0,
  307.     kTextEncodingBaseName        = 0,
  308.     kTextEncodingVariantName    = 0,
  309.     kTextEncodingFormatName        = 0
  310. };
  311.  
  312. /* Types used in conversion */
  313. struct ScriptCodeRun {
  314.     ByteOffset                         offset;
  315.     ScriptCode                         script;
  316. };
  317. typedef struct ScriptCodeRun ScriptCodeRun;
  318.  
  319. typedef ScriptCodeRun *ScriptCodeRunPtr;
  320. typedef const ScriptCodeRun *ConstScriptCodeRunPtr;
  321. struct TextEncodingRun {
  322.     ByteOffset                         offset;
  323.     TextEncoding                     textEncoding;
  324. };
  325. typedef struct TextEncodingRun TextEncodingRun;
  326.  
  327. typedef UInt8 *TextPtr;
  328. typedef const UInt8 *ConstTextPtr;
  329. typedef TextEncodingRun *TextEncodingRunPtr;
  330. typedef TextEncodingRun *ConstTextEncodingRunPtr;
  331. /* enums for TextEncoding Conversion routines */
  332.  
  333. enum {
  334.     kTextScriptDontCare            = -128,
  335.     kTextLanguageDontCare        = -128,
  336.     kTextRegionDontCare            = -128
  337. };
  338.  
  339. /* Prototypes for TextEncoding functions */
  340. extern pascal TextEncoding CreateTextEncoding(TextEncodingBase encodingBase, TextEncodingVariant encodingVariant, TextEncodingFormat encodingFormat);
  341.  
  342. extern pascal TextEncodingBase GetTextEncodingBase(TextEncoding encoding);
  343.  
  344. extern pascal TextEncodingVariant GetTextEncodingVariant(TextEncoding encoding);
  345.  
  346. extern pascal TextEncodingFormat GetTextEncodingFormat(TextEncoding encoding);
  347.  
  348. extern pascal TextEncoding ResolveDefaultTextEncoding(TextEncoding encoding);
  349.  
  350. extern OSStatus GetTextEncodingName(TextEncoding iEncoding, TextEncodingNameSelector iNamePartSelector, RegionCode iPreferredRegion, TextEncoding iPreferredEncoding, ByteCount iBufLen, ByteCount *oNameLength, RegionCode *oActualRegion, TextEncoding *oActualEncoding, TextPtr oEncodingName);
  351.  
  352. extern pascal OSStatus UpgradeScriptInfoToTextEncoding(ScriptCode textScriptID, LangCode textLanguageID, RegionCode regionID, ConstStr255Param textFontname, TextEncoding *encoding);
  353.  
  354. extern pascal OSStatus RevertTextEncodingToScriptInfo(TextEncoding encoding, ScriptCode *textScriptID, LangCode *textLanguageID, Str255 textFontname);
  355.  
  356.  
  357. #if PRAGMA_ALIGN_SUPPORTED
  358. #pragma options align=reset
  359. #endif
  360.  
  361. #if PRAGMA_IMPORT_SUPPORTED
  362. #pragma import off
  363. #endif
  364.  
  365. #ifdef __cplusplus
  366. }
  367. #endif
  368.  
  369. #endif /* __TEXTCOMMON__ */
  370.  
  371.